<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: BlobField.html 966 2015-01-28 18:06:10Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.vaadin.data.Property;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.vaadin.ui.Alignment;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import com.vaadin.ui.Component;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import com.vaadin.ui.CustomField;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import com.vaadin.ui.HorizontalLayout;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import com.vaadin.ui.Label;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import com.vaadin.ui.Notification;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import com.vaadin.ui.ProgressBar;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import com.vaadin.ui.Upload;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.ByteArrayOutputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.OutputStream;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.slf4j.Logger;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.LoggerFactory;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * A Vaadin {@link com.vaadin.ui.Field} for editing {@link Property}s with {@code byte[]} array values<a name="line.27"></a>
<span class="sourceLineNo">028</span> * (i.e., "blobs"). The blob is updated using a file upload.<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span>@SuppressWarnings("serial")<a name="line.30"></a>
<span class="sourceLineNo">031</span>public class BlobField extends CustomField&lt;byte[]&gt; implements Upload.Receiver,<a name="line.31"></a>
<span class="sourceLineNo">032</span>  Upload.StartedListener, Upload.ProgressListener, Upload.SucceededListener, Upload.FailedListener {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    protected final Logger log = LoggerFactory.getLogger(this.getClass());<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>    private final Label descriptionLabel = new Label();<a name="line.36"></a>
<span class="sourceLineNo">037</span>    private final HorizontalLayout layout = new HorizontalLayout();<a name="line.37"></a>
<span class="sourceLineNo">038</span>    private final ByteArrayOutputStream buffer = new ByteArrayOutputStream();<a name="line.38"></a>
<span class="sourceLineNo">039</span>    private final ProgressBar progressBar = new ProgressBar();<a name="line.39"></a>
<span class="sourceLineNo">040</span>    private final Upload upload = new Upload();<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Constructor.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     */<a name="line.44"></a>
<span class="sourceLineNo">045</span>    public BlobField() {<a name="line.45"></a>
<span class="sourceLineNo">046</span>        this.addValueChangeListener(new Property.ValueChangeListener() {<a name="line.46"></a>
<span class="sourceLineNo">047</span>            @Override<a name="line.47"></a>
<span class="sourceLineNo">048</span>            public void valueChange(Property.ValueChangeEvent event) {<a name="line.48"></a>
<span class="sourceLineNo">049</span>                BlobField.this.updateDisplay();<a name="line.49"></a>
<span class="sourceLineNo">050</span>            }<a name="line.50"></a>
<span class="sourceLineNo">051</span>        });<a name="line.51"></a>
<span class="sourceLineNo">052</span>        this.addReadOnlyStatusChangeListener(new Property.ReadOnlyStatusChangeListener() {<a name="line.52"></a>
<span class="sourceLineNo">053</span>            @Override<a name="line.53"></a>
<span class="sourceLineNo">054</span>            public void readOnlyStatusChange(Property.ReadOnlyStatusChangeEvent event) {<a name="line.54"></a>
<span class="sourceLineNo">055</span>                BlobField.this.updateDisplay();<a name="line.55"></a>
<span class="sourceLineNo">056</span>            }<a name="line.56"></a>
<span class="sourceLineNo">057</span>        });<a name="line.57"></a>
<span class="sourceLineNo">058</span>    }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span>    @Override<a name="line.60"></a>
<span class="sourceLineNo">061</span>    public void attach() {<a name="line.61"></a>
<span class="sourceLineNo">062</span>        super.attach();<a name="line.62"></a>
<span class="sourceLineNo">063</span>        this.updateDisplay();<a name="line.63"></a>
<span class="sourceLineNo">064</span>    }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    // Cancel any upload in progress if we are detached<a name="line.66"></a>
<span class="sourceLineNo">067</span>    @Override<a name="line.67"></a>
<span class="sourceLineNo">068</span>    public void detach() {<a name="line.68"></a>
<span class="sourceLineNo">069</span>        super.detach();<a name="line.69"></a>
<span class="sourceLineNo">070</span>        this.upload.interruptUpload();<a name="line.70"></a>
<span class="sourceLineNo">071</span>    }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>    /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * Get the {@link Upload} associated with this instance.<a name="line.74"></a>
<span class="sourceLineNo">075</span>     */<a name="line.75"></a>
<span class="sourceLineNo">076</span>    public Upload getUpload() {<a name="line.76"></a>
<span class="sourceLineNo">077</span>        return this.upload;<a name="line.77"></a>
<span class="sourceLineNo">078</span>    }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>    /**<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * Get the description {@link Label} associated with this instance.<a name="line.81"></a>
<span class="sourceLineNo">082</span>     */<a name="line.82"></a>
<span class="sourceLineNo">083</span>    public Label getDescriptionLabel() {<a name="line.83"></a>
<span class="sourceLineNo">084</span>        return this.descriptionLabel;<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>// CustomField<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    @Override<a name="line.89"></a>
<span class="sourceLineNo">090</span>    public Class&lt;byte[]&gt; getType() {<a name="line.90"></a>
<span class="sourceLineNo">091</span>        return byte[].class;<a name="line.91"></a>
<span class="sourceLineNo">092</span>    }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span>    @Override<a name="line.94"></a>
<span class="sourceLineNo">095</span>    protected Component initContent() {<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>        // Initialize layout<a name="line.97"></a>
<span class="sourceLineNo">098</span>        this.layout.setMargin(false);<a name="line.98"></a>
<span class="sourceLineNo">099</span>        this.layout.setSpacing(true);<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span>        // Add description<a name="line.101"></a>
<span class="sourceLineNo">102</span>        this.descriptionLabel.setSizeUndefined();<a name="line.102"></a>
<span class="sourceLineNo">103</span>        this.layout.addComponent(this.descriptionLabel);<a name="line.103"></a>
<span class="sourceLineNo">104</span>        this.layout.setComponentAlignment(this.descriptionLabel, Alignment.MIDDLE_LEFT);<a name="line.104"></a>
<span class="sourceLineNo">105</span>        this.layout.addComponent(new Label("\u00a0\u00a0"));<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span>        // Add upload<a name="line.107"></a>
<span class="sourceLineNo">108</span>        this.upload.setReceiver(this);<a name="line.108"></a>
<span class="sourceLineNo">109</span>        this.upload.addStartedListener(this);<a name="line.109"></a>
<span class="sourceLineNo">110</span>        this.upload.addProgressListener(this);<a name="line.110"></a>
<span class="sourceLineNo">111</span>        this.upload.addSucceededListener(this);<a name="line.111"></a>
<span class="sourceLineNo">112</span>        this.upload.addFailedListener(this);<a name="line.112"></a>
<span class="sourceLineNo">113</span>        this.upload.setImmediate(true);<a name="line.113"></a>
<span class="sourceLineNo">114</span>        this.layout.addComponent(this.upload);<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>        // Add progress bar<a name="line.116"></a>
<span class="sourceLineNo">117</span>        this.progressBar.setIndeterminate(false);<a name="line.117"></a>
<span class="sourceLineNo">118</span>        this.progressBar.setVisible(false);<a name="line.118"></a>
<span class="sourceLineNo">119</span>        this.layout.addComponent(this.progressBar);<a name="line.119"></a>
<span class="sourceLineNo">120</span>        this.layout.setComponentAlignment(this.progressBar, Alignment.MIDDLE_LEFT);<a name="line.120"></a>
<span class="sourceLineNo">121</span>        this.layout.setExpandRatio(this.progressBar, 1.0f);<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>        // Done<a name="line.123"></a>
<span class="sourceLineNo">124</span>        return layout;<a name="line.124"></a>
<span class="sourceLineNo">125</span>    }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>    @Override<a name="line.127"></a>
<span class="sourceLineNo">128</span>    protected void setInternalValue(byte[] value) {<a name="line.128"></a>
<span class="sourceLineNo">129</span>        super.setInternalValue(value);<a name="line.129"></a>
<span class="sourceLineNo">130</span>        this.updateDisplay();<a name="line.130"></a>
<span class="sourceLineNo">131</span>    }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>// Upload.Receiver<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>    @Override<a name="line.135"></a>
<span class="sourceLineNo">136</span>    public OutputStream receiveUpload(String filename, String mimeType) {<a name="line.136"></a>
<span class="sourceLineNo">137</span>        return this.buffer;<a name="line.137"></a>
<span class="sourceLineNo">138</span>    }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span>// Upload.StartedListener<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span>    @Override<a name="line.142"></a>
<span class="sourceLineNo">143</span>    public void uploadStarted(Upload.StartedEvent event) {<a name="line.143"></a>
<span class="sourceLineNo">144</span>        this.log.info("started upload of file `" + event.getFilename() + "'");<a name="line.144"></a>
<span class="sourceLineNo">145</span>        this.progressBar.setValue(0.0f);<a name="line.145"></a>
<span class="sourceLineNo">146</span>        this.progressBar.setVisible(true);<a name="line.146"></a>
<span class="sourceLineNo">147</span>        this.updateDisplay();<a name="line.147"></a>
<span class="sourceLineNo">148</span>    }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span>// Upload.ProgressListener<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span>    @Override<a name="line.152"></a>
<span class="sourceLineNo">153</span>    public void updateProgress(long readBytes, long contentLength) {<a name="line.153"></a>
<span class="sourceLineNo">154</span>        float fraction = (float)readBytes / (float)contentLength;<a name="line.154"></a>
<span class="sourceLineNo">155</span>        fraction = Math.max(fraction, 0.0f);<a name="line.155"></a>
<span class="sourceLineNo">156</span>        fraction = Math.min(fraction, 1.0f);<a name="line.156"></a>
<span class="sourceLineNo">157</span>        fraction = (int)(fraction * 64.0f) / 64.0f;                 // quantize fraction to avoid zillions of PUSH updates<a name="line.157"></a>
<span class="sourceLineNo">158</span>        this.progressBar.setValue(fraction);<a name="line.158"></a>
<span class="sourceLineNo">159</span>    }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>// Upload.SucceededListener<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>    @Override<a name="line.163"></a>
<span class="sourceLineNo">164</span>    public void uploadSucceeded(Upload.SucceededEvent event) {<a name="line.164"></a>
<span class="sourceLineNo">165</span>        final byte[] data = this.buffer.toByteArray();<a name="line.165"></a>
<span class="sourceLineNo">166</span>        this.log.info("finished upload of file `" + event.getFilename() + "' (" + data.length + " bytes)");<a name="line.166"></a>
<span class="sourceLineNo">167</span>        this.buffer.reset();<a name="line.167"></a>
<span class="sourceLineNo">168</span>        this.setValue(data);<a name="line.168"></a>
<span class="sourceLineNo">169</span>        this.progressBar.setVisible(false);<a name="line.169"></a>
<span class="sourceLineNo">170</span>        this.updateDisplay();<a name="line.170"></a>
<span class="sourceLineNo">171</span>    }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span>// Upload.FailedListener<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span>    @Override<a name="line.175"></a>
<span class="sourceLineNo">176</span>    public void uploadFailed(Upload.FailedEvent event) {<a name="line.176"></a>
<span class="sourceLineNo">177</span>        this.log.info("failed upload of file `" + event.getFilename() + "': " + event.getReason());<a name="line.177"></a>
<span class="sourceLineNo">178</span>        this.progressBar.setVisible(false);<a name="line.178"></a>
<span class="sourceLineNo">179</span>        this.updateDisplay();<a name="line.179"></a>
<span class="sourceLineNo">180</span>        if (this.getUI() != null) {<a name="line.180"></a>
<span class="sourceLineNo">181</span>            final Notification notification = new Notification("Upload failed",<a name="line.181"></a>
<span class="sourceLineNo">182</span>              "" + event.getReason(), Notification.Type.ERROR_MESSAGE);<a name="line.182"></a>
<span class="sourceLineNo">183</span>            notification.setDelayMsec(3000);<a name="line.183"></a>
<span class="sourceLineNo">184</span>            notification.show(this.getUI().getPage());<a name="line.184"></a>
<span class="sourceLineNo">185</span>        }<a name="line.185"></a>
<span class="sourceLineNo">186</span>    }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span>// Internal Methods<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span>    /**<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * Update the description label to reflect the current property value and read-only status.<a name="line.191"></a>
<span class="sourceLineNo">192</span>     */<a name="line.192"></a>
<span class="sourceLineNo">193</span>    protected void updateDisplay() {<a name="line.193"></a>
<span class="sourceLineNo">194</span>        final byte[] value = this.getValue();<a name="line.194"></a>
<span class="sourceLineNo">195</span>        this.descriptionLabel.setValue(value != null ? value.length + " bytes" : "Null");<a name="line.195"></a>
<span class="sourceLineNo">196</span>        this.upload.setEnabled(!this.isReadOnly());<a name="line.196"></a>
<span class="sourceLineNo">197</span>    }<a name="line.197"></a>
<span class="sourceLineNo">198</span>}<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>




























































</pre>
</div>
</body>
</html>
